Cisco-IOS-XR-infra-rsi-cfg API API Reference
API generated from Cisco-IOS-XR-infra-rsi-cfg@2017-05-01.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string"
}
VPN-ID - Update
Update operation of resource: vpn-id
vpn-idbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VPN-ID - Create
Create operation of resource: vpn-id
vpn-idbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VPN-ID - Delete
Delete operation of resource: vpn-id
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VPN-ID - Retrieve
Retrieve operation of resource: vpn-id
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of af-name saf-name topology-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of af-name saf-name topology-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of af-name saf-name topology-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of af-name saf-name topology-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
GLOBAL-AF - Update
Update operation of resource: global-af
global-afbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-AF - Create
Create operation of resource: global-af
global-afbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-AF - Delete
Delete operation of resource: global-af
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-AF - Retrieve
Retrieve operation of resource: global-af
AFS - Update
Update operation of resource: afs
afsbody object
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
Successful operation
Internal Error
AF - Update
Update operation of resource: af
afbody object
ID of af-name saf-name topology-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of af-name saf-name topology-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of af-name saf-name topology-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of af-name saf-name topology-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
SRLG - Update
Update operation of resource: srlg
srlgbody object
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}, { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ], {
"srlg-name": "string",
"srlg-value": "integer"
}
]
}, {
"group-name": "string",
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SRLG - Create
Create operation of resource: srlg
srlgbody object
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}, { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ], {
"srlg-name": "string",
"srlg-value": "integer"
}
]
}, {
"group-name": "string",
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SRLG - Delete
Delete operation of resource: srlg
Successful operation
Internal Error
Response Content-Types: application/json
SRLG - Retrieve
Retrieve operation of resource: srlg
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}, { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ], {
"srlg-name": "string",
"srlg-value": "integer"
}
]
}, {
"group-name": "string",
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ], {
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string", "priority": "string",
"enable": [ null ]
}, {
"srlg-name": "string"
}
]
}
}
INCLUDE-OPTICAL - Update
Update operation of resource: include-optical
include-opticalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
INCLUDE-OPTICAL - Create
Create operation of resource: include-optical
include-opticalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"priority": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
INCLUDE-OPTICAL - Delete
Delete operation of resource: include-optical
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INCLUDE-OPTICAL - Retrieve
Retrieve operation of resource: include-optical
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string",
"enable": [ null ]
}
INTERFACE-GROUP - Update
Update operation of resource: interface-group
interface-groupbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-GROUP - Create
Create operation of resource: interface-group
interface-groupbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-GROUP - Delete
Delete operation of resource: interface-group
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-GROUP - Retrieve
Retrieve operation of resource: interface-group
ID of interface-name
Successful operation
Internal Error
GROUP-NAMES - Update
Update operation of resource: group-names
group-namesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAMES - Create
Create operation of resource: group-names
group-namesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAMES - Delete
Delete operation of resource: group-names
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAMES - Retrieve
Retrieve operation of resource: group-names
ID of interface-name
Successful operation
Internal Error
GROUP-NAME - Update
Update operation of resource: group-name
group-namebody object
ID of interface-name
ID of group-name-index
Request Content-Types: application/json
Request Example
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAME - Create
Create operation of resource: group-name
group-namebody object
ID of interface-name
ID of group-name-index
Request Content-Types: application/json
Request Example
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAME - Delete
Delete operation of resource: group-name
ID of interface-name
ID of group-name-index
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-NAME - Retrieve
Retrieve operation of resource: group-name
ID of interface-name
ID of group-name-index
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
VALUES - Update
Update operation of resource: values
valuesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VALUES - Create
Create operation of resource: values
valuesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VALUES - Delete
Delete operation of resource: values
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VALUES - Retrieve
Retrieve operation of resource: values
ID of interface-name
Successful operation
Internal Error
VALUE - Update
Update operation of resource: value
valuebody object
ID of interface-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VALUE - Create
Create operation of resource: value
valuebody object
ID of interface-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VALUE - Delete
Delete operation of resource: value
ID of interface-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
VALUE - Retrieve
Retrieve operation of resource: value
ID of interface-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
INTERFACE-SRLG-NAMES - Update
Update operation of resource: interface-srlg-names
interface-srlg-namesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAMES - Create
Create operation of resource: interface-srlg-names
interface-srlg-namesbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAMES - Delete
Delete operation of resource: interface-srlg-names
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAMES - Retrieve
Retrieve operation of resource: interface-srlg-names
ID of interface-name
Successful operation
Internal Error
INTERFACE-SRLG-NAME - Update
Update operation of resource: interface-srlg-name
interface-srlg-namebody object
ID of interface-name
ID of srlg-name
Request Content-Types: application/json
Request Example
{
"srlg-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAME - Create
Create operation of resource: interface-srlg-name
interface-srlg-namebody object
ID of interface-name
ID of srlg-name
Request Content-Types: application/json
Request Example
{
"srlg-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAME - Delete
Delete operation of resource: interface-srlg-name
ID of interface-name
ID of srlg-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-SRLG-NAME - Retrieve
Retrieve operation of resource: interface-srlg-name
ID of interface-name
ID of srlg-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-name": "string"
}
SRLG-NAMES - Update
Update operation of resource: srlg-names
srlg-namesbody object
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAMES - Create
Create operation of resource: srlg-names
srlg-namesbody object
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAMES - Delete
Delete operation of resource: srlg-names
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAMES - Retrieve
Retrieve operation of resource: srlg-names
Successful operation
Internal Error
SRLG-NAME - Update
Update operation of resource: srlg-name
srlg-namebody object
ID of srlg-name
Request Content-Types: application/json
Request Example
{
"srlg-name": "string",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAME - Create
Create operation of resource: srlg-name
srlg-namebody object
ID of srlg-name
Request Content-Types: application/json
Request Example
{
"srlg-name": "string",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAME - Delete
Delete operation of resource: srlg-name
ID of srlg-name
Successful operation
Internal Error
Response Content-Types: application/json
SRLG-NAME - Retrieve
Retrieve operation of resource: srlg-name
ID of srlg-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-name": "string",
"srlg-value": "integer"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
GROUP - Update
Update operation of resource: group
groupbody object
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of group-name
Successful operation
Internal Error
GROUP-VALUES - Update
Update operation of resource: group-values
group-valuesbody object
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUES - Create
Create operation of resource: group-values
group-valuesbody object
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUES - Delete
Delete operation of resource: group-values
ID of group-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUES - Retrieve
Retrieve operation of resource: group-values
ID of group-name
Successful operation
Internal Error
GROUP-VALUE - Update
Update operation of resource: group-value
group-valuebody object
ID of group-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUE - Create
Create operation of resource: group-value
group-valuebody object
ID of group-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUE - Delete
Delete operation of resource: group-value
ID of group-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-VALUE - Retrieve
Retrieve operation of resource: group-value
ID of group-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
INHERIT-NODES - Update
Update operation of resource: inherit-nodes
inherit-nodesbody object
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODES - Create
Create operation of resource: inherit-nodes
inherit-nodesbody object
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODES - Delete
Delete operation of resource: inherit-nodes
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODES - Retrieve
Retrieve operation of resource: inherit-nodes
Successful operation
Internal Error
INHERIT-NODE - Update
Update operation of resource: inherit-node
inherit-nodebody object
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE - Create
Create operation of resource: inherit-node
inherit-nodebody object
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE - Delete
Delete operation of resource: inherit-node
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE - Retrieve
Retrieve operation of resource: inherit-node
ID of inherit-node-name
Successful operation
Internal Error
INHERIT-NODE-VALUES - Update
Update operation of resource: inherit-node-values
inherit-node-valuesbody object
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUES - Create
Create operation of resource: inherit-node-values
inherit-node-valuesbody object
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUES - Delete
Delete operation of resource: inherit-node-values
ID of inherit-node-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUES - Retrieve
Retrieve operation of resource: inherit-node-values
ID of inherit-node-name
Successful operation
Internal Error
INHERIT-NODE-VALUE - Update
Update operation of resource: inherit-node-value
inherit-node-valuebody object
ID of inherit-node-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUE - Create
Create operation of resource: inherit-node-value
inherit-node-valuebody object
ID of inherit-node-name
ID of srlg-index
Request Content-Types: application/json
Request Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUE - Delete
Delete operation of resource: inherit-node-value
ID of inherit-node-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
INHERIT-NODE-VALUE - Retrieve
Retrieve operation of resource: inherit-node-value
ID of inherit-node-name
ID of srlg-index
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
VRF-GROUPS - Update
Update operation of resource: vrf-groups
vrf-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUPS - Create
Create operation of resource: vrf-groups
vrf-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUPS - Delete
Delete operation of resource: vrf-groups
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUPS - Retrieve
Retrieve operation of resource: vrf-groups
Successful operation
Internal Error
VRF-GROUP - Update
Update operation of resource: vrf-group
vrf-groupbody object
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUP - Create
Create operation of resource: vrf-group
vrf-groupbody object
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUP - Delete
Delete operation of resource: vrf-group
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-GROUP - Retrieve
Retrieve operation of resource: vrf-group
ID of vrf-group-name
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of vrf-group-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of vrf-group-name
Successful operation
Internal Error
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-group-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-group-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-group-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-group-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string"
}
SELECTIVE-VRF-DOWNLOAD - Update
Update operation of resource: selective-vrf-download
selective-vrf-downloadbody object
Request Content-Types: application/json
Request Example
{
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Create
Create operation of resource: selective-vrf-download
selective-vrf-downloadbody object
Request Content-Types: application/json
Request Example
{
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Delete
Delete operation of resource: selective-vrf-download
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Retrieve
Retrieve operation of resource: selective-vrf-download
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"disable": [ null ]
}
GLOBAL-INTERFACE-CONFIGURATION - Update
Update operation of resource: global-interface-configuration
global-interface-configurationbody object
Request Content-Types: application/json
Request Example
{
"link-status": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Create
Create operation of resource: global-interface-configuration
global-interface-configurationbody object
Request Content-Types: application/json
Request Example
{
"link-status": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Delete
Delete operation of resource: global-interface-configuration
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: global-interface-configuration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-status": "string"
}
INTERFACE-CONFIGURATIONS - Update
Update operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ { "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Create
Create operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ { "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Delete
Delete operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Retrieve
Retrieve operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
]
}
INTERFACE-CONFIGURATION - Update
Update operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Create
Create operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Delete
Delete operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer", {
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string", {
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
], {
"af-name": "string",
"saf-name": "string"
}
]
}
}
DAMPENING - Update
Update operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Create
Create operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Delete
Delete operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Retrieve
Retrieve operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
MTUS - Update
Update operation of resource: mtus
mtusbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Create
Create operation of resource: mtus
mtusbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Delete
Delete operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Retrieve
Retrieve operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
MTU - Update
Update operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Request Content-Types: application/json
Request Example
{
"owner": "string",
"mtu": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Create
Create operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Request Content-Types: application/json
Request Example
{
"owner": "string",
"mtu": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Delete
Delete operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Retrieve
Retrieve operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"owner": "string",
"mtu": "integer"
}
ENCAPSULATION - Update
Update operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"encapsulation": "string",
"capsulation-options": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Create
Create operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"encapsulation": "string",
"capsulation-options": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Delete
Delete operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Retrieve
Retrieve operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"encapsulation": "string",
"capsulation-options": "integer"
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of active interface-name
Successful operation
Internal Error
AF - Update
Update operation of resource: af
afbody object
ID of active interface-name
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of active interface-name
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of active interface-name
ID of af-name saf-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of active interface-name
ID of af-name saf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"saf-name": "string"
}
AF-TOPOLOGY-NAME - Update
Update operation of resource: af-topology-name
af-topology-namebody object
ID of active interface-name
ID of topology-name af-name saf-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF-TOPOLOGY-NAME - Create
Create operation of resource: af-topology-name
af-topology-namebody object
ID of active interface-name
ID of topology-name af-name saf-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF-TOPOLOGY-NAME - Delete
Delete operation of resource: af-topology-name
ID of active interface-name
ID of topology-name af-name saf-name
Successful operation
Internal Error
Response Content-Types: application/json
AF-TOPOLOGY-NAME - Retrieve
Retrieve operation of resource: af-topology-name
ID of active interface-name
ID of topology-name af-name saf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
SELECTIVE-VRF-DOWNLOAD - Update
Update operation of resource: selective-vrf-download
selective-vrf-downloadbody object
Request Content-Types: application/json
Request Example
{
"role-change": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Create
Create operation of resource: selective-vrf-download
selective-vrf-downloadbody object
Request Content-Types: application/json
Request Example
{
"role-change": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Delete
Delete operation of resource: selective-vrf-download
Successful operation
Internal Error
Response Content-Types: application/json
SELECTIVE-VRF-DOWNLOAD - Retrieve
Retrieve operation of resource: selective-vrf-download
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role-change": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
Schema Definitions
AF-TABLE:
Common node of vrf, global-af
- afs: object
-
VRF address family configuration
-
- af: object[]
-
VRF address family configuration
-
object - af-name: string ipv4, ipv6
-
Address family
- create: null
-
VRF configuration for a particular address family
- topology-name: string
-
Topology name
- saf-name: string unicast, multicast, flow-spec
-
Sub-Address family
Example
{
"afs": {
"af": [
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
]
}
}
vrfs_schema:
Set of VRFs configured under a VRF group
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
Example
{
"vrf": [
{
"vrf-name": "string"
}
]
}
vpn-id_schema:
VPN-ID for the VRF
- vpn-oui: integer
-
OUI of VPNID OUI
range:"0..16777215" - vpn-index: integer
-
Index of VPNID Index
range:"0..4294967295"
Example
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
afs_schema:
VRF address family configuration
- af: object[]
-
VRF address family configuration
-
object - af-name: string ipv4, ipv6
-
Address family
- create: null
-
VRF configuration for a particular address family
- topology-name: string
-
Topology name
- saf-name: string unicast, multicast, flow-spec
-
Sub-Address family
Example
{
"af": [
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
]
}
af_schema:
- af-name: string ipv4, ipv6
-
Address family
- create: null
-
VRF configuration for a particular address family
- topology-name: string
-
Topology name
- saf-name: string unicast, multicast, flow-spec
-
Sub-Address family
Example
{
"af-name": "string",
"create": [ null ],
"topology-name": "string",
"saf-name": "string"
}
srlg_schema:
srlg
- inherit-nodes: object
-
Set of inherit nodes configured with SRLG
-
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
- interfaces: object
-
Set of interfaces configured with SRLG
-
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
- enable: null
-
Enable SRLG
- srlg-names: object
-
Set of SRLG name configuration
-
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
- groups: object
-
Set of groups configured with SRLG
-
- group: object[]
-
Group configurations
-
object - group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-nodes": {
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
},
"interfaces": {
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ],
"srlg-names": {
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
},
"groups": {
"group": [
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
interfaces_schema:
Set of interfaces configured with SRLG
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
}
interface_schema:
- interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
include-optical_schema:
Include optical configuration for an interface
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
Example
{
"priority": "string",
"enable": [ null ]
}
interface-group_schema:
Group configuration for an interface
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
Example
{
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
}
group-names_schema:
Set of group name under an interface
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
}
group-name_schema:
- group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
values_schema:
SRLG Value configuration for an interface
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
interface-srlg-names_schema:
SRLG Name configuration for an interface
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
srlg-names_schema:
Set of SRLG name configuration
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
}
srlg-name_schema:
- srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": "string",
"srlg-value": "integer"
}
groups_schema:
Set of groups configured with SRLG
- group: object[]
-
Group configurations
-
object - group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group": [
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
group_schema:
- group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
group-values_schema:
Set of SRLG values configured under a group
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
group-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
inherit-nodes_schema:
Set of inherit nodes configured with SRLG
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}
inherit-node_schema:
- enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
inherit-node-values_schema:
Set of SRLG values configured under an inherit node
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
inherit-node-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
vrf-groups_schema:
vrf groups
- vrf-group: object[]
-
VRF group configuration
-
object - enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"vrf-group": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
]
}
vrf-group_schema:
- enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
selective-vrf-download_schema:
selective vrf download
- disable: null
-
Disable selective VRF download
Example
{
"disable": [ null ]
}
a1_vrfs_schema:
Set of VRFs configured under a VRF group
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
Example
{
"vrf": [
{
"vrf-name": "string"
}
]
}
a1_vpn-id_schema:
VPN-ID for the VRF
- vpn-oui: integer
-
OUI of VPNID OUI
range:"0..16777215" - vpn-index: integer
-
Index of VPNID Index
range:"0..4294967295"
Example
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
a1_afs_schema:
Per-address-family and topology configuration
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
a1_af_schema:
- af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"af-name": "string",
"saf-name": "string"
}
a1_srlg_schema:
srlg
- inherit-nodes: object
-
Set of inherit nodes configured with SRLG
-
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
- interfaces: object
-
Set of interfaces configured with SRLG
-
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
- enable: null
-
Enable SRLG
- srlg-names: object
-
Set of SRLG name configuration
-
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
- groups: object
-
Set of groups configured with SRLG
-
- group: object[]
-
Group configurations
-
object - group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-nodes": {
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
},
"interfaces": {
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ],
"srlg-names": {
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
},
"groups": {
"group": [
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
a1_interfaces_schema:
Set of interfaces configured with SRLG
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
}
a1_interface_schema:
- interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
a1_include-optical_schema:
Include optical configuration for an interface
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
Example
{
"priority": "string",
"enable": [ null ]
}
a1_interface-group_schema:
Group configuration for an interface
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
Example
{
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
}
a1_group-names_schema:
Set of group name under an interface
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
}
a1_group-name_schema:
- group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
a1_values_schema:
SRLG Value configuration for an interface
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a1_value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a1_interface-srlg-names_schema:
SRLG Name configuration for an interface
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
a1_srlg-names_schema:
Set of SRLG name configuration
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
}
a1_srlg-name_schema:
- srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": "string",
"srlg-value": "integer"
}
a1_groups_schema:
Set of groups configured with SRLG
- group: object[]
-
Group configurations
-
object - group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group": [
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
a1_group_schema:
- group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
a1_group-values_schema:
Set of SRLG values configured under a group
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a1_group-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a1_inherit-nodes_schema:
Set of inherit nodes configured with SRLG
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}
a1_inherit-node_schema:
- enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
a1_inherit-node-values_schema:
Set of SRLG values configured under an inherit node
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a1_inherit-node-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a1_vrf-groups_schema:
vrf groups
- vrf-group: object[]
-
VRF group configuration
-
object - enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"vrf-group": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
]
}
a1_vrf-group_schema:
- enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
a1_selective-vrf-download_schema:
selective vrf download
- disable: null
-
Disable selective VRF download
Example
{
"disable": [ null ]
}
a1_global-interface-configuration_schema:
Global scoped configuration for interfaces
- link-status: string default, disable, software-interfaces
-
Enable or disable link-status messages
Example
{
"link-status": "string"
}
a1_interface-configurations_schema:
interface configurations
- interface-configuration: object[]
-
The configuration for an interface
-
object - dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- description: string
-
The description of this interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- link-status: null
-
Enable interface and line-protocol state change alarms
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- vrf: string
-
Assign the interface to a VRF
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- interface-name: string
-
The name of the interface
- afs: object
-
Per-address-family and topology configuration
-
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"interface-configuration": [
{
"dampening": {
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer",
"mtus": {
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string",
"afs": {
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
}
]
}
a1_interface-configuration_schema:
- dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- description: string
-
The description of this interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- link-status: null
-
Enable interface and line-protocol state change alarms
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- vrf: string
-
Assign the interface to a VRF
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- interface-name: string
-
The name of the interface
- afs: object
-
Per-address-family and topology configuration
-
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"dampening": {
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer",
"mtus": {
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string",
"afs": {
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
}
a1_dampening_schema:
Whether this interface's state changes are dampened or not
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
a1_mtus_schema:
The MTU configuration for the interface
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
}
a1_mtu_schema:
- owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"owner": "string",
"mtu": "integer"
}
a1_encapsulation_schema:
The encapsulation on the interface
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
Example
{
"encapsulation": "string",
"capsulation-options": "integer"
}
a1_af-topology-name_schema:
- af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
Example
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
a2_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a2_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a2_vpn-id_schema:
VPN-ID for the VRF
- vpn-oui: integer
-
OUI of VPNID OUI
range:"0..16777215" - vpn-index: integer
-
Index of VPNID Index
range:"0..4294967295"
Example
{
"vpn-oui": "integer",
"vpn-index": "integer"
}
a2_afs_schema:
Per-address-family and topology configuration
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
a2_af_schema:
- af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"af-name": "string",
"saf-name": "string"
}
a2_srlg_schema:
srlg
- inherit-nodes: object
-
Set of inherit nodes configured with SRLG
-
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
- interfaces: object
-
Set of interfaces configured with SRLG
-
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
- enable: null
-
Enable SRLG
- srlg-names: object
-
Set of SRLG name configuration
-
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
- groups: object
-
Set of groups configured with SRLG
-
- group: object[]
-
Group configurations
-
object - group-name: string
-
Group name
- enable: null
-
Enable SRLG group
- group-values: object
-
Set of SRLG values configured under a group
-
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-nodes": {
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
},
"interfaces": {
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
},
"enable": [ null ],
"srlg-names": {
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
},
"groups": {
"group": [
{
"group-name": "string",
"enable": [ null ],
"group-values": {
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
}
]
}
}
a2_interfaces_schema:
Set of interfaces configured with SRLG
- interface: object[]
-
Interface configurations
-
object - interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface": [
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
]
}
a2_interface_schema:
- interface-group: object
-
Group configuration for an interface
-
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
- enable: null
-
Enable SRLG interface
- values: object
-
SRLG Value configuration for an interface
-
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- interface-name: string
-
Interface name
- include-optical: object
-
Include optical configuration for an interface
-
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
- interface-srlg-names: object
-
SRLG Name configuration for an interface
-
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-group": {
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
},
"enable": [ null ],
"values": {
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"interface-name": "string",
"include-optical": {
"priority": "string",
"enable": [ null ]
},
"interface-srlg-names": {
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
}
a2_include-optical_schema:
Include optical configuration for an interface
- priority: string critical, high, default, low, very-low
-
Priority for optical domain values
- enable: null
-
Enable SRLG interface include optical
Example
{
"priority": "string",
"enable": [ null ]
}
a2_interface-group_schema:
Group configuration for an interface
- group-names: object
-
Set of group name under an interface
-
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- enable: null
-
Enable SRLG interface group submode
Example
{
"group-names": {
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
},
"enable": [ null ]
}
a2_group-names_schema:
Set of group name under an interface
- group-name: object[]
-
Group name included under interface
-
object - group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name": [
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
]
}
a2_group-name_schema:
- group-name-index: integer
-
Group name index
- group-name: string
-
Group name
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
Example
{
"group-name-index": "integer",
"group-name": "string",
"srlg-priority": "string"
}
a2_values_schema:
SRLG Value configuration for an interface
- value: object[]
-
SRLG value data
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a2_value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a2_interface-srlg-names_schema:
SRLG Name configuration for an interface
- interface-srlg-name: object[]
-
SRLG name data
-
object - srlg-name: string
-
SRLG name
Example
{
"interface-srlg-name": [
{
"srlg-name": "string"
}
]
}
a2_srlg-names_schema:
Set of SRLG name configuration
- srlg-name: object[]
-
SRLG name configuration
-
object - srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": [
{
"srlg-name": "string",
"srlg-value": "integer"
}
]
}
a2_srlg-name_schema:
- srlg-name: string
-
SRLG name
- srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-name": "string",
"srlg-value": "integer"
}
a2_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a2_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
a2_group-values_schema:
Set of SRLG values configured under a group
- group-value: object[]
-
Group SRLG values with attribute
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"group-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a2_group-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a2_inherit-nodes_schema:
Set of inherit nodes configured with SRLG
- inherit-node: object[]
-
Inherit node configurations
-
object - enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"inherit-node": [
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
]
}
a2_inherit-node_schema:
- enable: null
-
Enable SRLG inherit node
- inherit-node-values: object
-
Set of SRLG values configured under an inherit node
-
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
- inherit-node-name: string
-
The inherit node name
Example
{
"enable": [ null ],
"inherit-node-values": {
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
},
"inherit-node-name": "string"
}
a2_inherit-node-values_schema:
Set of SRLG values configured under an inherit node
- inherit-node-value: object[]
-
Inherit node SRLG value with attributes
-
object - srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"inherit-node-value": [
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
]
}
a2_inherit-node-value_schema:
- srlg-priority: string critical, high, default, low, very-low
-
SRLG priority
- srlg-index: integer
-
SRLG index
range:"1..65535" - srlg-value: integer
-
SRLG value
range:"0..4294967295"
Example
{
"srlg-priority": "string",
"srlg-index": "integer",
"srlg-value": "integer"
}
a2_vrf-groups_schema:
vrf groups
- vrf-group: object[]
-
VRF group configuration
-
object - enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"vrf-group": [
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
]
}
a2_vrf-group_schema:
- enable: null
-
Enable VRF group
- vrfs: object
-
Set of VRFs configured under a VRF group
-
- vrf: object[]
-
VRF configuration
-
object - vrf-name: string
-
VRF name
- vrf-group-name: string
-
VRF group name
Example
{
"enable": [ null ],
"vrfs": {
"vrf": [
{
"vrf-name": "string"
}
]
},
"vrf-group-name": "string"
}
a2_selective-vrf-download_schema:
CISCO-SELECTIVE-VRF-DOWNLOAD-MIB notification configuration
- role-change: null
-
Enable csvdEntityRoleChangeNotification notification
Example
{
"role-change": [ null ]
}
a2_global-interface-configuration_schema:
Global scoped configuration for interfaces
- link-status: string default, disable, software-interfaces
-
Enable or disable link-status messages
Example
{
"link-status": "string"
}
a2_interface-configurations_schema:
interface configurations
- interface-configuration: object[]
-
The configuration for an interface
-
object - dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- description: string
-
The description of this interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- link-status: null
-
Enable interface and line-protocol state change alarms
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- vrf: string
-
Assign the interface to a VRF
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- interface-name: string
-
The name of the interface
- afs: object
-
Per-address-family and topology configuration
-
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"interface-configuration": [
{
"dampening": {
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer",
"mtus": {
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string",
"afs": {
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
}
]
}
a2_interface-configuration_schema:
- dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- description: string
-
The description of this interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- link-status: null
-
Enable interface and line-protocol state change alarms
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- vrf: string
-
Assign the interface to a VRF
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- interface-name: string
-
The name of the interface
- afs: object
-
Per-address-family and topology configuration
-
- af-topology-name: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
- af: object[]
-
The presence of this object enables the givenaddress-family and topology on the interface.
-
object - af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
Example
{
"dampening": {
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
},
"description": "string",
"secondary-admin-state": "string",
"interface-virtual": [ null ],
"link-status": [ null ],
"bandwidth": "integer",
"mtus": {
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
},
"vrf": "string",
"shutdown": [ null ],
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"interface-mode-non-physical": "string",
"interface-name": "string",
"afs": {
"af-topology-name": [
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
],
"af": [
{
"af-name": "string",
"saf-name": "string"
}
]
}
}
a2_dampening_schema:
Whether this interface's state changes are dampened or not
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
a2_mtus_schema:
The MTU configuration for the interface
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
}
a2_mtu_schema:
- owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"owner": "string",
"mtu": "integer"
}
a2_encapsulation_schema:
The encapsulation on the interface
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
Example
{
"encapsulation": "string",
"capsulation-options": "integer"
}
a2_af-topology-name_schema:
- af-name: string ipv4, ipv6
-
Address-family
- saf-name: string unicast, multicast, flow-spec
-
Sub-address-family
- topology-name: string
-
Topology name
Example
{
"af-name": "string",
"saf-name": "string",
"topology-name": "string"
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a2_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a2_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a2_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a2_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a2_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a2_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a2_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a2_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a2_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a2_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a2_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a2_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a2_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a2_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a2_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a2_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a2_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a2_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a2_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a2_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a2_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a2_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a2_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a2_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a2_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a2_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a2_notification_schema:
Enable SNMP notifications
- selective-vrf-download: object
-
CISCO-SELECTIVE-VRF-DOWNLOAD-MIB notification configuration
-
- role-change: null
-
Enable csvdEntityRoleChangeNotification notification
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"selective-vrf-download": {
"role-change": [ null ]
},
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
}
a2_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a2_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a2_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a2_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a2_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a2_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a2_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a2_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a2_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a2_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a2_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a2_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a2_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a2_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a2_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a2_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a2_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a2_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a2_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a2_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a2_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a2_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a2_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a2_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a2_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a2_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a2_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a2_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a2_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a2_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a2_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a2_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a2_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a2_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a2_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a2_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a2_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}